/****

    activequant - activestocks.eu

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

	
	contact  : contact@activestocks.eu
    homepage : http://www.activestocks.eu

 ****/
package org.activequant.calendar;

import java.util.TimeZone;

import org.activequant.core.types.Exchange;

/**
 * Interface for exchange calendar settings.<br/>
 * An interface. Defines the following methods:
 * <ul>
 * <li>Exchange getExchange()</li>
 * <li>TimeZone getTimeZone()</li>
 * <li>long getRegularOpeningTime()</li>
 * <li>long getRegularClosingTime()</li>
 * </ul>
 * <br/>
 * <b>History:</b><br>
 * - [May 31, 2008] Created (mark)<br>
 * - [Sep 5, 2008] renamed getOpeningTime and getClosingTime to getRegularOpeningTime and getRegularClosingTime (mark)<br>
 * 
 * @author mark
 */
public interface IExchangeCalendarSettings {
	/**
	 * Get the exchange for the exchange's calendar settings.
	 * 
	 * @return the <code>Exchange</code> for the exchange calendar.
	 */
	Exchange getExchange();

	/**
	 * Get the exchange's calendar settings time zone.
	 * 
	 * @return the time zone for the exchange calendar
	 */
	TimeZone getTimeZone();

	/**
	 * Get the exchange calendar's settings regular opening time.
	 * 
	 * @return the exchange calendar opening time in milliseconds after midnight (exchange's calendar settings time
	 *         zone)
	 */
	long getRegularOpeningTime();

	/**
	 * Get the exchange calendar's settings regular closing time.
	 * 
	 * @return the exchange calendar closing time in milliseconds after midnight (exchange's calendar settings time
	 *         zone)
	 */
	long getRegularClosingTime();
}
